﻿' ******************************************************************************
' ** 
' **  Yahoo Finance Managed
' **  Written by Marius Häusler 2010
' **  It would be pleasant, if you contact me when you are using this code.
' **  Contact: YahooFinanceManaged@gmail.com
' **  Project Home: http://code.google.com/p/yahoo-finance-managed/
' **  
' ******************************************************************************
' **  
' **  Copyright 2010 Marius Häusler
' **  
' **  Licensed under the Apache License, Version 2.0 (the "License");
' **  you may not use this file except in compliance with the License.
' **  You may obtain a copy of the License at
' **  
' **    http://www.apache.org/licenses/LICENSE-2.0
' **  
' **  Unless required by applicable law or agreed to in writing, software
' **  distributed under the License is distributed on an "AS IS" BASIS,
' **  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
' **  See the License for the specific language governing permissions and
' **  limitations under the License.
' ** 
' ******************************************************************************


Namespace Finance

    ''' <summary>
    ''' Stores informations about one historic trading period (day, week or month). Serializable. 
    ''' </summary>
    ''' <remarks></remarks>
    <Serializable()> _
    Public Class HistQuoteData
        Private mValues(4) As Double
        Private mVolume As Long
        Private mTradingDate As Date

        ''' <summary>
        ''' The startdate of the period.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property TradingDate() As Date
            Get
                Return mTradingDate
            End Get
            Set(ByVal value As Date)
                mTradingDate = value
            End Set
        End Property
        ''' <summary>
        ''' The traded volume.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Volume() As Long
            Get
                Return mVolume
            End Get
            Set(ByVal value As Long)
                mVolume = value
            End Set
        End Property
        ''' <summary>
        ''' The first value in trading period.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Open() As Double
            Get
                Return mValues(0)
            End Get
            Set(ByVal value As Double)
                mValues(0) = value
            End Set
        End Property
        ''' <summary>
        ''' The highest value in trading period.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property High() As Double
            Get
                Return mValues(1)
            End Get
            Set(ByVal value As Double)
                mValues(1) = value
            End Set
        End Property
        ''' <summary>
        ''' The lowest value in trading period.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Low() As Double
            Get
                Return mValues(2)
            End Get
            Set(ByVal value As Double)
                mValues(2) = value
            End Set
        End Property
        ''' <summary>
        ''' The last value in trading period.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Close() As Double
            Get
                Return mValues(3)
            End Get
            Set(ByVal value As Double)
                mValues(3) = value
            End Set
        End Property
        ''' <summary>
        ''' The last value in trading period in relation to share splits.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property CloseAdjusted() As Double
            Get
                Return mValues(4)
            End Get
            Set(ByVal value As Double)
                mValues(4) = value
            End Set
        End Property

    End Class


    ''' <summary>
    ''' HistQuotesDataChain class is a container for a list of HistQuoteData. Implements IID. Implements IEnumerable(Of HistQuoteData).
    ''' </summary>
    ''' <remarks></remarks>
    Public Class HistQuotesDataChain
        Implements ISettableID
        Implements IEnumerable(Of HistQuoteData)

        Private mID As String = String.Empty
        Private mItems As List(Of HistQuoteData)

        ''' <summary>
        ''' The ID of the historic quotes owning stock, index, etc.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public ReadOnly Property ID() As String Implements IID.ID
            Get
                Return mID
            End Get
        End Property
        Public Sub SetID(ByVal id As String) Implements ISettableID.SetID
            mID = id
        End Sub
        ''' <summary>
        ''' Gets a historical quotes data item by index parameter.
        ''' </summary>
        ''' <param name="index">The index position of the historic quotes data</param>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Default Public Property ItemAt(ByVal index As Integer) As HistQuoteData
            Get
                Return mItems(index)
            End Get
            Set(ByVal value As HistQuoteData)
                mItems(index) = value
            End Set
        End Property
        ''' <summary>
        ''' Gets all historic quotes data items as list.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public ReadOnly Property Items() As List(Of HistQuoteData)
            Get
                Return mItems
            End Get
        End Property
        Public ReadOnly Property Count() As Integer
            Get
                Return mItems.Count
            End Get
        End Property

        Public Sub New()
            mItems = New List(Of HistQuoteData)
        End Sub
        Public Sub New(ByVal id As String)
            Me.New()
            mID = id
        End Sub
        Public Sub New(ByVal items As IEnumerable(Of HistQuoteData))
            mItems = New List(Of HistQuoteData)(items)
        End Sub
        Public Sub New(ByVal id As String, ByVal items As IEnumerable(Of HistQuoteData))
            Me.New(items)
            mID = id
        End Sub

        Public Function GetEnumerator() As System.Collections.Generic.IEnumerator(Of HistQuoteData) Implements System.Collections.Generic.IEnumerable(Of HistQuoteData).GetEnumerator
            Return mItems.GetEnumerator
        End Function
        Public Function GetEnumerator1() As System.Collections.IEnumerator Implements System.Collections.IEnumerable.GetEnumerator
            Return mItems.GetEnumerator
        End Function

    End Class

End Namespace